JBoss Community Archive (Read Only)

RHQ 4.5

JBossAS - ConnectionFactory Service

Overview

Internal Name:

ConnectionFactory

Description:

 

Singleton:

no

Plugin:

JBossAS

Connection Settings

Name

Description

Required

Internal Name

Object Name

 

yes

objectName

Name Template

 

yes

nameTemplate

Description Template

 

yes

descriptionTemplate

Name

The name of this Connection Factory

yes

name

You must use the internal name to reference properties in Dynamic Group Definition expressions.

Metrics

Name

Type

Description

Internal Name

Available Connection Count

measurement

Number of available connections.

AvailableConnectionCount

Connection Count

measurement

Connection Count

ConnectionCount

Connection Created Count

measurement

Connection Created Count

ConnectionCreatedCount

Connection Destroyed Count

measurement

Connection Destroyed Count

ConnectionDestroyedCount

In Use Connection Count

measurement

Mumber of connections currently in use.

InUseConnectionCount

Max Connections In Use Count

measurement

Maximum number of maximum connections that have been in use.

MaxConnectionsInUseCount

Max Size

measurement

Max Size

MaxSize

Min Size

measurement

Min Size

MinSize

You must use the internal name to reference traits in Dynamic Group Definition expressions.

Configuration Properties

Name

Description

Required

Internal Name

Connection Factory Type

Connection Factory Type (Tx or no Tx)

yes

type

JNDI Name

The JNDI Name under which the DataSource wrapper will be bound.

yes

jndi-name

User Name

This element specifies the default username used when creating a new connection. The actual username may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject.

no

user-name

Password

This element specifies the default password used when creating a new connection. The actual password may be overridden by the application code getConnection parameters or the connection creation context JAAS Subject.

no

password

Minimum Pool Size

Indicates the minimum number of connections the pool should hold.

no

min-pool-size

Maximum Pool Size

Indicates the maximum number of connections the pool should hold.

no

max-pool-size

Application Managed Security

Specifying this element indicates that connections in the pool should be distinguished
by application code supplied parameters, such as from getConnection(user, pw). This requires
that you set a security domain which will populate a security-domain-and-application tag. If it is missing
this resource will not be created or saved.

no

application-managed-security

Security Domain/Security Domain and Application

Indicates Subjects from security domain are used to distinguish connections in
this pool. If Application Managed Security is set to true, then this will create a security-domain
tag. If it is set to false or unset, then this property will populate a security-domain-and-application
tag.

no

security-domain

Adapter Display Name

used to identify the RAR deployment matching the display-name in the ra.xml

no

adapter-display-name

Depends

The depends element specifies the JMX ObjectName string of a service that the connection manager services depend on. The connection manager service will not be started until the dependent services have been started.

no

depends

Rar Name

This is the name of the RAR file that contains the definition for the resource we want to provide. For nested RAR files, the name would look like myapplication.ear#my.rar.

yes

rar-name

Connection Definition

This is the connection factory interface class. It should match the connectionfactory-interface in the ra.xml file.

yes

connection-definition

Type Mappings

This element declares a default type mapping for this datasource. The type mapping should match a type-mapping/name element from standardjbosscmp-jdbc.xml.

no

type-mapping

Use Java Context

Indicates if the JNDI name should be prefixed with java:.

no

use-java-context

Transaction Type

Whether to use local or xa transactions. If nothing is specified, the default of local will be used.

no

transaction-type

No Tx Separate Pools

The presence of this element indicates that two connection pools are required to
isolate connections used with JTA transaction from those used without a JTA transaction.
The pools are lazily constructed on first use. Its use case is for Oracle
(and possibly other vendors) XA implementations that don't like using an XA connection with
and without a JTA transaction.

no

no-tx-separate-pools

Track Connection By Transaction

Whether the connection should be locked into the transaction.

no

track-connection-by-tx

isSameRM Override Value

Allows one to unconditionally set whether the
javax.transaction.xa.XAResource.isSameRMXAResource returns true or false. The default is not
to override the return value.

no

isSameRM-override-value

Use Strict Minimum

Whether on not to use strict minumum.

no

use-strict-min

Prefill

Prefill the Pool with Connection objects, or lazy load objects in the pool

no

prefill

Blocking Timeout in Milliseconds

Indicates the maximum time in milliseconds to block while waiting for a connection before throwing
an exception. Note that this blocks only while waiting for a permit for a connection, and will never
throw an exception if creating a new connection takes an inordinately long time. If nothing is specified
the default of 30000 milliseconds is used.

no

blocking-timeout-millis

Idle Timeout

Maximum time in minutes a connection can be idle before it is closed.

no

idle-timeout-minutes

XA Resource Timeout

Maximum time in minutes an XA Resource can be idle before it is removed.

no

xa-resource-timeout

New Connection SQL

Specify an SQL statement to execute whenever a connection is added to the connection pool.

no

new-connection-sql

Check Valid Connection SQL

Specify an SQL statement to check validity of a pool connection. This may be called when managed connection is taken from pool for use.

no

check-valid-connection-sql

Config Property

Configuration Properties

no

config-property

You must use the internal name to reference properties in Dynamic Group Definition expressions.

JBoss.org Content Archive (Read Only), exported from JBoss Community Documentation Editor at 2020-03-12 12:58:04 UTC, last content change 2012-05-09 12:35:12 UTC.